/*
 * File Name     : @(#)IEventDelegate.java
 * Creation Date : Mar 2, 2009
 * Author        : anirudh
 * 
 * Copyright 2009 Anirudh Vyas
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package hcis.core.engine.event.delegate;

import hcis.core.engine.event.IEvent;
import hcis.core.engine.event.listener.IEventListener;
import hcis.dto.IDTO;
import hcis.model.IModel;
import hcis.model.annotation.HCISEntity;

import java.io.Serializable;

/**
 * <pre>
 * &lt;p&gt;
 *        Core event delegate interface contract that all event delegates must adhere
 *        to. Internally an event delegate must maintain a map of events and
 *        corresponding listeners, which are called and executed when an event occurs.
 * &lt;/p&gt;
 * 
 * &lt;p&gt;
 *        In future we can have a concept of phases in the event delegate; Essentially
 *        when a request comes, all phases will be executed, these phases will be fixed
 *        and will be aligned with JSF Phases or any other phase based UI framework,
 *        each phase typically will be executed by a phase Listener, and phase listener
 *        will execute whatever events are queued on it; as of today the event delegate
 *        works as a hook to listeners.
 * &lt;/p&gt;
 * </pre>
 * 
 * @author avyas
 * @param <LISTENER>
 *            listener type.
 * @param <EVENT>
 *            event type.
 * @param <SOURCE>
 *            source type.
 * @param <MODEL>
 *            model type.
 * @param <MODELID>
 *            model id type.
 */
@HCISEntity
public interface IEventDelegate<LISTENER extends IEventListener<EVENT, SOURCE, MODEL, MODELID>, EVENT extends IEvent<SOURCE, MODEL, MODELID>, SOURCE extends IDTO<MODEL, MODELID>, MODEL extends IModel<MODELID>, MODELID extends Serializable> {

}
